Interface FTPUserAccountManager

All Superinterfaces:
IPCObject
All Known Implementing Classes:
FTPUserAccountManagerImpl

public interface FTPUserAccountManager extends IPCObject
Information provided by the PKI file:

    \class FtpUserAccountManager
    
    \brief FtpUserAccountManager manages user accounts for FTP servers.
    
    \example network().getDevice("Server0").getProcess("FtpServer").getFtpUserAccountManager()
    
Author:
Auto-generated
  • Method Details

    • addFtpUser

      void addFtpUser(String username, String password, String perms)
      Information provided by the PKI file:
      
          \brief Adds an FTP user account with the specified username, password, and permissions.
          
          \param username, the username for the account.
          \param password, the password for the account.
          \param perms,       the permissions for the account.
          Permissions:
          R - Read
          W - Write
          N - Rename
          L - List
          D - Delete
          Example: "RW" will permit read and write operations
          
              
      Parameters:
      username - Takes in a parameter of username
      password - Takes in a parameter of password
      perms - Takes in a parameter of perms
    • removeFtpUser

      void removeFtpUser(String username)
      Information provided by the PKI file:
      
          \brief Removes the specified FTP user account.
          
          \param username, the username of the account of interest.
          
              
      Parameters:
      username - Takes in a parameter of username
    • isExistingUser

      boolean isExistingUser(String username)
      Information provided by the PKI file:
      
          \brief Returns true if the specified username already exists, otherwise false.
          
          \param username, the username of the account of interest.
          
          \return bool, true if the specified username already exists, otherwise false.
          
              
      Parameters:
      username - Takes in a parameter of username
      Returns:
      boolean Returns a boolean
    • getUsersCount

      int getUsersCount()
      Information provided by the PKI file:
      
          \brief Returns the number of users accounts.
          
          \return int, the number of users accounts.
          
              
      Returns:
      int Returns a int
    • getUsernameAt

      String getUsernameAt(int i)
      Information provided by the PKI file:
      
          \brief Returns the username at given index.
          
          \param i, index of the user.
          
          \return string, the username at given index.
          
              
      Parameters:
      i - Takes in a parameter of i
      Returns:
      String Returns a String
    • getPasswordAt

      String getPasswordAt(int i)
      Information provided by the PKI file:
      
          \brief Returns the password at given index.
          
          \param i, index of the user.
          
          \return string, the password at given index.
          
              
      Parameters:
      i - Takes in a parameter of i
      Returns:
      String Returns a String
    • getPermissionAt

      String getPermissionAt(int i)
      Information provided by the PKI file:
      
          \brief Returns the permission at given index.
          
          \param i, index of the user.
          
          \return string, the permission at given index.
          
              
      Parameters:
      i - Takes in a parameter of i
      Returns:
      String Returns a String